Additions
authorMatthias Clasen <matthiasc@src.gnome.org>
Thu, 8 Jun 2006 03:47:29 +0000 (03:47 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Thu, 8 Jun 2006 03:47:29 +0000 (03:47 +0000)
docs/reference/ChangeLog
docs/reference/gtk/gtk-sections.txt
docs/reference/gtk/tmpl/gtkprintoperation.sgml

index a562fbd9018995c51b219a755080abf3e43d745f..71ca588b1509c7f4c6361a03cb14f2ebc88c4765 100644 (file)
@@ -1,3 +1,8 @@
+2006-06-07  Matthias Clasen  <mclasen@redhat.com>
+
+       * gtk/tmpl/gtkprintoperation.sgml:
+       * gtk/gtk-sections.txt: Additions
+
 2006-06-05  Matthias Clasen  <mclasen@redhat.com>
 
        * === Released 2.9.2 ===
index eaeb897f3083745f67fb8c87216b50ff668a1405..7b021d4a07e266c9638558f9c1c295d929286db2 100644 (file)
@@ -4502,6 +4502,8 @@ gtk_tree_view_set_destroy_count_func
 GtkTreeViewRowSeparatorFunc
 gtk_tree_view_get_row_separator_func
 gtk_tree_view_set_row_separator_func
+gtk_tree_view_get_rubber_banding
+gtk_tree_view_set_rubber_banding
 <SUBSECTION Standard>
 GtkTreeSelectionClass
 GTK_TREE_VIEW
@@ -5922,6 +5924,7 @@ GTK_STOCK_OPEN
 GTK_STOCK_ORIENTATION_LANDSCAPE
 GTK_STOCK_ORIENTATION_PORTRAIT
 GTK_STOCK_ORIENTATION_REVERSE_LANDSCAPE
+GTK_STOCK_ORIENTATION_REVERSE_PORTRAIT
 GTK_STOCK_PASTE
 GTK_STOCK_PREFERENCES
 GTK_STOCK_PRINT
@@ -6074,10 +6077,13 @@ gtk_icon_source_get_type
 <TITLE>High-level Printing API</TITLE>
 GtkPrintOperation
 GtkPrintStatus
+GtkPrintOperationAction
 GtkPrintOperationResult
 GtkPrintError
 GTK_PRINT_ERROR
 gtk_print_operation_new
+gtk_print_operation_set_allow_async
+gtk_print_operation_get_error
 gtk_print_operation_set_default_page_setup
 gtk_print_operation_get_default_page_setup
 gtk_print_operation_set_print_settings
@@ -6093,15 +6099,21 @@ gtk_print_operation_set_show_progress
 gtk_print_operation_set_track_print_status
 gtk_print_operation_set_custom_tab_label
 gtk_print_operation_run
-gtk_print_operation_run_async
 gtk_print_operation_cancel
 gtk_print_operation_get_status
 gtk_print_operation_get_status_string
 gtk_print_operation_is_finished
+gtk_print_operation_get_error
 gtk_print_run_page_setup_dialog
 GtkPageSetupDoneFunc
 gtk_print_run_page_setup_dialog_async
 
+<SUBSECTION Preview>
+GtkPrintOperationPreview
+gtk_print_operation_preview_end_preview
+gtk_print_operation_preview_is_selected
+gtk_print_operation_preview_render_page
+
 <SUBSECTION Standard>
 GTK_TYPE_PRINT_OPERATION
 GTK_PRINT_OPERATION
@@ -6109,10 +6121,15 @@ GTK_IS_PRINT_OPERATION
 GTK_IS_PRINT_OPERATION_CLASS
 GTK_PRINT_OPERATION_CLASS
 GTK_PRINT_OPERATION_GET_CLASS
+GTK_IS_PRINT_OPERATION_PREVIEW
+GTK_PRINT_OPERATION_PREVIEW
+GTK_PRINT_OPERATION_PREVIEW_GET_IFACE
+GTK_TYPE_PRINT_OPERATION_PREVIEW
 
 <SUBSECTION Private>
 gtk_print_error_quark
 gtk_print_operation_get_type
+gtk_print_operation_preview_get_type
 GtkPrintOperationPrivate
 </SECTION>
 
@@ -6367,6 +6384,7 @@ gtk_page_setup_get_type
 <TITLE>GtkPrintContext</TITLE>
 GtkPrintContext
 gtk_print_context_get_cairo_context
+gtk_print_context_set_cairo_context
 gtk_print_context_get_page_setup
 gtk_print_context_get_width
 gtk_print_context_get_height
index 2266874777237e1e0c3e162c2ebf1ae3dd694ac4..9f3ccfc80b399825078824df436f4575fe32c8d9 100644 (file)
@@ -48,7 +48,8 @@ do_print (void)
   g_signal_connect (print, "begin_print", G_CALLBACK (begin_print), NULL);
   g_signal_connect (print, "draw_page", G_CALLBACK (draw_page), NULL);
 
-  res = gtk_print_operation_run (print, GTK_WINDOW (main_window), NULL);
+  res = gtk_print_operation_run (print, GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG,
+                                 GTK_WINDOW (main_window), NULL);
 
   if (res == GTK_PRINT_OPERATION_RESULT_APPLY)
     {
@@ -86,15 +87,15 @@ Printing support was added in GTK+ 2.10.
 
 </para>
 
-@printoperation: the object which received the signal.
-@arg1
+@printoperation: 
+@context
 
 <!-- ##### SIGNAL GtkPrintOperation::create-custom-widget ##### -->
 <para>
 
 </para>
 
-@printoperation: the object which received the signal.
+@printoperation: 
 @Returns: 
 
 <!-- ##### SIGNAL GtkPrintOperation::custom-widget-apply ##### -->
@@ -102,9 +103,17 @@ Printing support was added in GTK+ 2.10.
 
 </para>
 
-@printoperation: the object which received the signal.
+@printoperation: 
 @widget: 
 
+<!-- ##### SIGNAL GtkPrintOperation::done ##### -->
+<para>
+
+</para>
+
+@printoperation: the object which received the signal.
+@arg1: 
+
 <!-- ##### SIGNAL GtkPrintOperation::draw-page ##### -->
 <para>
 
@@ -159,6 +168,11 @@ Printing support was added in GTK+ 2.10.
 
 @printoperation: the object which received the signal.
 
+<!-- ##### ARG GtkPrintOperation:allow-async ##### -->
+<para>
+
+</para>
+
 <!-- ##### ARG GtkPrintOperation:current-page ##### -->
 <para>
 
@@ -194,16 +208,6 @@ Printing support was added in GTK+ 2.10.
 
 </para>
 
-<!-- ##### ARG GtkPrintOperation:show-dialog ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkPrintOperation:show-preview ##### -->
-<para>
-
-</para>
-
 <!-- ##### ARG GtkPrintOperation:show-progress ##### -->
 <para>
 
@@ -236,28 +240,51 @@ Printing support was added in GTK+ 2.10.
 
 <!-- ##### ENUM GtkPrintStatus ##### -->
 <para>
+The status gives a rough indication of the completion
+of a running print operation.
+</para>
+
+@GTK_PRINT_STATUS_INITIAL: The printing has not started yet; this
+  status is set initially, and while the print dialog is shown.
+@GTK_PRINT_STATUS_PREPARING: This status is set while the begin-print 
+  signal is emitted and during pagination.
+@GTK_PRINT_STATUS_GENERATING_DATA: This status is set while the
+  pages are being rendered.
+@GTK_PRINT_STATUS_SENDING_DATA: The print job is being sent off to the 
+  printer.
+@GTK_PRINT_STATUS_PENDING: The print job has been sent to the printer,
+  but is not printed for some reason, e.g. the printer may be stopped.
+@GTK_PRINT_STATUS_PENDING_ISSUE: Some problem has occurred during 
+  printing, e.g. a paper jam.
+@GTK_PRINT_STATUS_PRINTING: The printer is processing the print job.
+@GTK_PRINT_STATUS_FINISHED: The printing has been completed successfully.
+@GTK_PRINT_STATUS_FINISHED_ABORTED: The printing has been aborted.
 
+<!-- ##### ENUM GtkPrintOperationAction ##### -->
+<para>
+The @action parameter to gtk_print_operation_run()
+determines what action the print operation should perform.
 </para>
 
-@GTK_PRINT_STATUS_INITIAL: 
-@GTK_PRINT_STATUS_PREPARING: 
-@GTK_PRINT_STATUS_GENERATING_DATA: 
-@GTK_PRINT_STATUS_SENDING_DATA: 
-@GTK_PRINT_STATUS_PENDING: 
-@GTK_PRINT_STATUS_PENDING_ISSUE: 
-@GTK_PRINT_STATUS_PRINTING: 
-@GTK_PRINT_STATUS_FINISHED: 
-@GTK_PRINT_STATUS_FINISHED_ABORTED: 
+@GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG: Show the print dialog. 
+@GTK_PRINT_OPERATION_ACTION_PRINT: Start to print without showing
+   the print dialog, based on the current print settings. 
+@GTK_PRINT_OPERATION_ACTION_PREVIEW: Show the print preview. 
+@GTK_PRINT_OPERATION_ACTION_EXPORT: Export to a file. This requires
+  the pdf-target to be set. 
 
 <!-- ##### ENUM GtkPrintOperationResult ##### -->
 <para>
-
+A value of this type is returned by gtk_print_operation_run().
 </para>
 
-@GTK_PRINT_OPERATION_RESULT_ERROR: 
-@GTK_PRINT_OPERATION_RESULT_APPLY: 
-@GTK_PRINT_OPERATION_RESULT_CANCEL: 
+@GTK_PRINT_OPERATION_RESULT_ERROR: An error has occured.
+@GTK_PRINT_OPERATION_RESULT_APPLY: The print settings should be stored.
+@GTK_PRINT_OPERATION_RESULT_CANCEL: The print operation has been canceled,
+  the print settings should not be stored.
 @GTK_PRINT_OPERATION_RESULT_PREVIEW: 
+@GTK_PRINT_OPERATION_RESULT_IN_PROGRESS: The print operation is complete
+  yet. This value will only be returned when running asynchronously.
 
 <!-- ##### ENUM GtkPrintError ##### -->
 <para>
@@ -283,6 +310,24 @@ The #GQuark used for #GtkPrintError errors.
 @Returns: 
 
 
+<!-- ##### FUNCTION gtk_print_operation_set_allow_async ##### -->
+<para>
+
+</para>
+
+@op: 
+@allow_async: 
+
+
+<!-- ##### FUNCTION gtk_print_operation_get_error ##### -->
+<para>
+
+</para>
+
+@op: 
+@Returns: 
+
+
 <!-- ##### FUNCTION gtk_print_operation_set_default_page_setup ##### -->
 <para>
 
@@ -364,15 +409,6 @@ The #GQuark used for #GtkPrintError errors.
 @unit: 
 
 
-<!-- ##### FUNCTION gtk_print_operation_set_show_dialog ##### -->
-<para>
-
-</para>
-
-@op: 
-@show_dialog: 
-
-
 <!-- ##### FUNCTION gtk_print_operation_set_pdf_target ##### -->
 <para>
 
@@ -415,29 +451,30 @@ The #GQuark used for #GtkPrintError errors.
 </para>
 
 @op: 
+@action: 
 @parent: 
 @error: 
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_print_operation_run_async ##### -->
+<!-- ##### FUNCTION gtk_print_operation_cancel ##### -->
 <para>
 
 </para>
 
 @op: 
-@parent: 
 
 
-<!-- ##### FUNCTION gtk_print_operation_cancel ##### -->
+<!-- ##### FUNCTION gtk_print_operation_get_status ##### -->
 <para>
 
 </para>
 
 @op: 
+@Returns: 
 
 
-<!-- ##### FUNCTION gtk_print_operation_get_status ##### -->
+<!-- ##### FUNCTION gtk_print_operation_get_status_string ##### -->
 <para>
 
 </para>
@@ -446,7 +483,7 @@ The #GQuark used for #GtkPrintError errors.
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_print_operation_get_status_string ##### -->
+<!-- ##### FUNCTION gtk_print_operation_is_finished ##### -->
 <para>
 
 </para>
@@ -455,7 +492,7 @@ The #GQuark used for #GtkPrintError errors.
 @Returns: 
 
 
-<!-- ##### FUNCTION gtk_print_operation_is_finished ##### -->
+<!-- ##### FUNCTION gtk_print_operation_get_error ##### -->
 <para>
 
 </para>
@@ -477,11 +514,14 @@ The #GQuark used for #GtkPrintError errors.
 
 <!-- ##### USER_FUNCTION GtkPageSetupDoneFunc ##### -->
 <para>
-
+The type of function that is passed to gtk_print_run_page_setup_dialog_async().
+This function will be called when the page setup dialog is dismissed, and
+also serves as destroy notify for @data.
 </para>
 
-@page_setup: 
-@data: 
+@page_setup: the #GtkPageSetup that has been
+@data: user data that has been passed to 
+       gtk_print_run_page_setup_dialog_async().
 
 
 <!-- ##### FUNCTION gtk_print_run_page_setup_dialog_async ##### -->
@@ -496,3 +536,36 @@ The #GQuark used for #GtkPrintError errors.
 @data: 
 
 
+<!-- ##### STRUCT GtkPrintOperationPreview ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION gtk_print_operation_preview_end_preview ##### -->
+<para>
+
+</para>
+
+@preview: 
+
+
+<!-- ##### FUNCTION gtk_print_operation_preview_is_selected ##### -->
+<para>
+
+</para>
+
+@preview: 
+@page_nr: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_print_operation_preview_render_page ##### -->
+<para>
+
+</para>
+
+@preview: 
+@page_nr: 
+
+